Export a Theme
{ exportTheme }
Exports an existing theme definition to a 'PAT' file.
Method
/API3/themes/exportTheme
- Enterprise Admin
Input Parameters
Name
themeId
Type
string
Description
The theme's system ID
Output Response
Successful Result Code
200
Response Type
Description of Response Type
The object representing the exported PIE file.
Notes
Use this API method to export a theme definition to be re-imported to another Pyramid instance
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/themes/exportTheme" \
-d ''
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ThemesServiceApi;
import java.util.*;
import java.time.*;
public class ThemesServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
ThemesServiceApi apiInstance = new ThemesServiceApi();
// Initialize the themeId parameter object for the call
String themeId = themeId_example; // Create the input object for the operation, type: String
try {
ExportData result = apiInstance.exportTheme(themeId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ThemesServiceApi#exportTheme");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ThemesServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const themeId = themeId_example; // {String}
api.exportTheme(themeId).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class exportThemeExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new ThemesServiceApi();
// Initialize the themeId parameter object for the call
var themeId = themeId_example; // Create the input object for the operation, type: String |
try {
// Exports an existing theme definition to a 'PAT' file.
ExportData result = apiInstance.exportTheme(themeId);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ThemesServiceApi.exportTheme: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import ThemesServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = ThemesServiceApi(api_client)
# Initialize the themeId parameter object for the call
themeId = themeId_example # String |
try:
# Exports an existing theme definition to a 'PAT' file.
api_response = api_instance.export_theme(themeId)
pprint(api_response)
except ApiException as e:
print("Exception when calling ThemesServiceApi->exportTheme: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ThemesServiceApi();
$themeId = themeId_example; // String |
try {
$result = $api_instance->exportTheme($themeId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ThemesServiceApi->exportTheme: ', $e->getMessage(), PHP_EOL;
}
?>